<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>MultiRangeIterator (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>

  <script type="text/javascript" src="//www.google.com/jsapi"></script>
  <script type="text/javascript">
     google.load("visualization", "1", {packages:["orgchart"]});
     var _loadingVisualizations = true;
  </script>

  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
        <span class="fn">dom.MultiRangeIterator</span>
        <span>Extends</span>
        <span class="fn-name">
          <a href="class_goog_dom_RangeIterator.html">
          goog.dom.RangeIterator
</a>
        </span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Subclass of goog.dom.TagIterator that iterates over a DOM range.  It
adds functions to determine the portion of each text node that is selected.


  </div>


        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="local_closure_goog_dom_multirange.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/dom/multirange.js">Git</a></li>
          </ol>
        </div>
</div>






<h2 class="g-first">Inheritance</h2>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
  <tr><td><span class="type"><a href="class_goog_iter_Iterator.html">goog.iter.Iterator</a></span></td><td></td></tr>
  <tr><td><span class="type"><a href="class_goog_dom_TagIterator.html">goog.dom.TagIterator</a></span></td><td><span class="type"><a href="class_goog_iter_Iterator.html">goog.iter.Iterator</a></span></td></tr>
  <tr><td><span class="type"><a href="class_goog_dom_RangeIterator.html">goog.dom.RangeIterator</a></span></td><td><span class="type"><a href="class_goog_dom_TagIterator.html">goog.dom.TagIterator</a></span></td></tr>
  <tr><td>goog.dom.MultiRangeIterator</td><td><span class="type"><a href="class_goog_dom_RangeIterator.html">goog.dom.RangeIterator</a></span></td></tr>
</table>
</div>
<div class='gviz-org-chart-container goog-inline-block'>
<table class='gviz-org-chart' style='display:none'>
</table>
</div>




  <h2>Constructor</h2>
      <div class="fn-constructor">
    goog.dom.MultiRangeIterator(<span><span class="arg">range</span></span>)
  </div>

   <h3>Parameters</h3>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">range</span>
        : <span class="type"><a href="class_goog_dom_MultiRange.html">goog.dom.MultiRange</a></span>
        <div class="entryOverview">The range to traverse.</div>
     </td>
   </tr>
  </table>


<h2>Instance Methods</h2>


  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_dom_MultiRangeIterator.html">
              goog.dom.MultiRangeIterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.clone"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">clone<span class="args">()</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="class_goog_dom_MultiRangeIterator.html">goog.dom.MultiRangeIterator</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="class_goog_dom_MultiRangeIterator.html">goog.dom.MultiRangeIterator</a></span>&nbsp;
            An identical iterator.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line517">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.copyFrom"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">copyFrom<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line507">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.getEndNode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getEndNode<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line474">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.getEndTextOffset"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getEndTextOffset<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line462">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.getStartNode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getStartNode<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line468">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.getStartTextOffset"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getStartTextOffset<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line456">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.isLast"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isLast<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line480">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.MultiRangeIterator.prototype.next"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">next<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line486">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_dom_RangeIterator.html">
              goog.dom.RangeIterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.RangeIterator.prototype.getEndNode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getEndNode<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>&nbsp;
            The iterator's end node.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_abstractrange.js.source.html#line522">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.RangeIterator.prototype.getEndTextOffset"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getEndTextOffset<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            The end offset into the current node, or -1 if the current
    node is not a text node.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_abstractrange.js.source.html#line510">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.RangeIterator.prototype.getStartNode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getStartNode<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>&nbsp;
            node The iterator's start node.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_abstractrange.js.source.html#line516">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.RangeIterator.prototype.getStartTextOffset"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getStartTextOffset<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&nbsp;
            The offset into the current node, or -1 if the current node
    is not a text node.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_abstractrange.js.source.html#line503">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.RangeIterator.prototype.isLast"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isLast<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether a call to next will fail.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_abstractrange.js.source.html#line528">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_dom_TagIterator.html">
              goog.dom.TagIterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.clone"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">clone<span class="args">()</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="class_goog_dom_TagIterator.html">goog.dom.TagIterator</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="class_goog_dom_TagIterator.html">goog.dom.TagIterator</a></span>&nbsp;
            A copy of this iterator.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line212">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry protected">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.copyFrom"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">copyFrom<span class="args">(<span class="arg">other</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Replace this iterator's values with values from another. The two iterators
must be of the same type.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">other</span>
        : <span class="type"><a href="class_goog_dom_TagIterator.html">goog.dom.TagIterator</a></span>
        <div class="entryOverview">The iterator to copy.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line200">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.equals"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">equals<span class="args">(<span class="arg">other</span>)</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       Test if two iterators are at the same position - i.e. if the node and tagType
is the same.  This will still return true if the two iterators are moving in
opposite directions or have different constraints.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">other</span>
        : <span class="type"><a href="class_goog_dom_TagIterator.html">goog.dom.TagIterator</a></span>
        <div class="entryOverview">The iterator to compare to.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether the two iterators are at the same position.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line338">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.isEndTag"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isEndTag<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether this iterator's position is an end tag position.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line318">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.isNonElement"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isNonElement<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether this iterator's position is not at an element node.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line326">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.isStartTag"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isStartTag<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether this iterator's position is a start tag position.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line310">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry protected">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.isStarted"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isStarted<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span>&nbsp;
            Whether next has ever been called on this iterator.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line302">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.next"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">next<span class="args">()</span>
        </span>
        &#8658; <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
      </div>


     <div class="entryOverview">
       Move to the next position in the DOM tree.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>&nbsp;
            Returns the next node, or throws a goog.iter.StopIteration
    exception if the end of the iterator's range has been reached.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line250">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.restartTag"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">restartTag<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Restart the current tag.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line234">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.setPosition"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setPosition<span class="args">(<span class="arg">node</span>,&nbsp;<span class="arg">opt_tagType</span>,&nbsp;<span class="arg">opt_depth</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Set the position of the iterator.  Overwrite the tree node and the position
type which can be one of the <code> goog.dom.TagWalkType</code> token types.
Only overwrites the tree depth when the parameter is specified.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">node</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/DOM/Node">Node</a></span>
        <div class="entryOverview">The node to set the position to.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_tagType</span>
        : <span class="type">goog.dom.TagWalkType?=</span>
        <div class="entryOverview">The type of the position
    Defaults to the start of the given node.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_depth</span>
        : <span class="type">number=</span>
        <div class="entryOverview">The tree depth.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line172">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.skipTag"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">skipTag<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Skip the current tag.

     </div>

   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line221">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.TagIterator.prototype.splice"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">splice<span class="args">(<span class="arg">var_args</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Replace the current node with the list of nodes. Reset the iterator so that
it visits the first of the nodes next.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">var_args</span>
        : <span class="type">...Object</span>
        <div class="entryOverview">A list of nodes to replace the current node with.
    If the first argument is array-like, it will be used, otherwise all the
    arguments are assumed to be nodes.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line353">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_iter_Iterator.html">
              goog.iter.Iterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.iter.Iterator.prototype.__iterator__"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">__iterator__<span class="args">(<span class="arg">opt_keys</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type"><a href="class_goog_iter_Iterator.html">goog.iter.Iterator</a></span>.&lt;<span class="type">VALUE</span>&gt;
      </div>


     <div class="entryOverview">
       Returns the <code> Iterator</code> object itself.  This is used to implement
the iterator protocol in JavaScript 1.7

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">opt_keys</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Whether to return the keys or values. Default is
    to only return the values.  This is being used by the for-in loop (true)
    and the for-each-in loop (false).  Even though the param gives a hint
    about what the iterator will return there is no guarantee that it will
    return the keys when true is passed.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type"><a href="class_goog_iter_Iterator.html">goog.iter.Iterator</a></span>.&lt;<span class="type">VALUE</span>&gt;&nbsp;
            The object itself.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_iter_iter.js.source.html#line88">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.iter.Iterator.prototype.next"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">next<span class="args">()</span>
        </span>
        &#8658; <span class="type">VALUE</span>
      </div>


     <div class="entryOverview">
       Returns the next value of the iteration.  This will throw the object
 when the iteration passes the end.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span class="type">VALUE</span>&nbsp;
            Any object or value.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_iter_iter.js.source.html#line73">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Instance Properties</h2>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_dom_MultiRangeIterator.html">
              goog.dom.MultiRangeIterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.dom.MultiRangeIterator.prototype.constructor"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">constructor</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line424">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.dom.MultiRangeIterator.prototype.currentIdx_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">currentIdx_</span>
        : 
     </div>


     <div class="entryOverview">
       The index of the current sub-iterator being traversed.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line452">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.dom.MultiRangeIterator.prototype.iterators_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">iterators_</span>
        : 
     </div>


     <div class="entryOverview">
       The list of range iterators left to traverse.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line444">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_dom_RangeIterator.html">
              goog.dom.RangeIterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.dom.RangeIterator.prototype.constructor"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">constructor</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_abstractrange.js.source.html#line493">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>

<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_dom_TagIterator.html">
              goog.dom.TagIterator
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.constrained"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">constrained</span>
        : 
     </div>


     <div class="entryOverview">
       Whether the iterator is constrained to the starting node and its children.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line152">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.constructor"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">constructor</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line100">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.depth"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">depth</span>
        : 
     </div>


     <div class="entryOverview">
       The tree depth of this position relative to where the iterator started.  The
depth is considered to be the tree depth just past the current node, so if an
iterator is at position <pre class="lang-js prettyprint"><div>|</div></pre>
(i.e. the node is the div and the type is START_TAG) its depth will be 1.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line138">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.node"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">node</span>
        : 
     </div>


     <div class="entryOverview">
       The node this position is located on.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line119">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.reversed"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">reversed</span>
        : 
     </div>


     <div class="entryOverview">
       Whether the node iterator is moving in reverse.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line145">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.started_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">started_</span>
        : 
     </div>


     <div class="entryOverview">
       Whether iteration has started.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line160">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.dom.TagIterator.prototype.tagType"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">tagType</span>
        : 
     </div>


     <div class="entryOverview">
       The type of this position.

     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_tagiterator.js.source.html#line126">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>










<div class="section">
  <table class="horiz-rule">


  </table>
</div>



<h2>Static Properties</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.dom.MultiRangeIterator.superClass_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.dom.MultiRangeIterator.</span><span class="entryName">superClass_</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_multirange.js.source.html#line424">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package dom</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="" current="dom.MultiRangeIterator"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
